Health Protection Electronic Notification (HPEN)
Domain Message Specification

OverseasTravelCountry Tabular View

COCD_TP146033GB01
OverseasTravelCountry

This template class constrains the CDA Observation class.

This class carries the dates of the overseas visit.

Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }
Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance
  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }
Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance
  • The XML attribute moodCode is fixed to "EVN"
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="OST" }
Model Attribute Description

The HL7 attribute code uses a code from a vocabulary to identify the observation type.

Implementation in XML Instance

When using this template then:

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
  • The XML attribute code is fixed to "OST"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall contain "Overseas Travel Country"
[0..1] effectiveTime (IVL<TS>)
Model Attribute Description

The HL7 attribute effectiveTime defines the time period during which the patient visited an overseas country.

Implementation in XML Instance

The Interval of Points in Time data type flavour is used to carry this information in the XML element effectiveTime using the value attributes of the of the XML elements low and high.

The date range shall be carried as follows:

The XML attribute value of the XML elements low and high, shall be populated with a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

yyyy is the year
mm is the month
dd is the day
hh is the hour
mm is the minute
ss is seconds
[+|-ZZzz] is the time zone offset in hours and minutes
Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

The Time Interval Complete data type shall be used:
  • The XML attribute value of the XML element low shall be populated with the date the overseas visit to the named country commenced
  • The XML attribute value of the XML element high shall be populated with the date the overseas visit to the named country ended.

Where only an approximate date of overseas travel is known, then

  • The XML attribute value of the XML elements low shall be populated with the approximate overseas visit. For example a visit in April 2013 may be represented as

<effectiveTime>
<low value="201304"/>
</effectiveTime>

[1..1] [M] id (II)
Model Attribute Description

The HL7 attribute id uses an identifier to identify each unique instance of a section.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows:
  • The XML attribute root shall contain a DCE UUID
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146033GB01#OverseasTravelCountry" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146033GB01#OverseasTravelCountry"
[1..1] [M] participant

This template class constrains the CDA participant class.

This class is a link to the visited overseas country code and name

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="ORG" }
Model Attribute Description

The HL7 attribute typeCode describes this class as an origin participation.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "ORG".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }
Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd in the actRelationships is set to " true".

The value of this attribute is fixed in the HL7 model to " OP":
  • "O" (Overriding) - the author replaces any author that has been conducted from any previous acts.
  • "P" (Propagating) - the author is conducted to all child acts where the contextConductionInd is set to "true".
Implementation in XML Instance
  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146033GB01#participant" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146033GB01#participant"
[1..1] [M] participantRole (ParticipantRole)
ParticipantRole

This template class constrains the CDA participantRole class.

This class is a link to the visited overseas country code and name

Used by: OverseasTravelCountry
[1..1] [M] classCode (CS { CNE: RoleClass } )
{ Fixed="LOCE" }
Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a located entity.

Implementation in XML Instance
  • The XML attribute classCode is fixed to "LOCE".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146033GB01#participantRole" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146033GB01#participantRole"
[1..1] [M] locationCountry (Country)
Country

This template class constrains the CDA scopingEntity class.

This class carries information about the country the patient has visited

Used by: ParticipantRole
[1..1] [M] classCode (CS { CNE: EntityClass } )
{ Fixed="COUNTRY" }
Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a country.

Implementation in XML Instance
  • The XML attribute classCode is fixed to "COUNTRY".
[1..1] [M] determinerCode (CS { CNE: EntityDeterminer } )
{ Fixed="INSTANCE" }
Model Attribute Description

The HL7 attribute determinerCode uses a code to describe this class as an instance of a country.

Implementation in XML Instance
  • The XML attribute determinerCode is fixed to "INSTANCE".
[1..1] [M] code (CV { CNE:ISOCountryCode } )
Model Attribute Description

The HL7 attribute code uses a code from a vocabulary to code each text section in the document to provide a mechanism to allow receivers to process and reuse text sections.

Implementation in XML Instance

When using this section template then:

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
  • The XML attribute code shall contain an ISO country code
  • The XML attribute codeSystem shall contain the OID "1.0.3166.1.2.3"
  • The XML attribute displayName shall contain the name of the country
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146033GB01#locationCountry" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146033GB01#locationCountry"